/* -*- mode: c -*-
 * Copyright (C) 2010, 2011 Lluís Vilanova <vilanova@ac.upc.edu>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

#ifndef TF_MM_ALLOC_H
#define TF_MM_ALLOC_H

#include <stdlib.h>


/** @file Memory allocation primitives */

#ifdef __cplusplus
extern "C" {
#endif

/** @todo calloc, realloc, memalign */

/** Dynamic memory allocation (see <ref>malloc(3)</ref>) */
void * tf_mm_alloc_malloc (size_t bytes) __attribute__((__malloc__, __alloc_size__(1)));
/** Dynamic memory free (see <ref>free(3)</ref>) */
void tf_mm_alloc_free (void * addr);

/** Set the value for the global pointer.
 * The global pointer solves the bootstrap problem of communicating the
 * address of the first dynamic memory allocation.
 */
void tf_mm_alloc_set_global (void * addr);
/** Get the value of the global pointer. */
void * tf_mm_alloc_get_global (void);

#ifdef __cplusplus
}
#endif

#endif  /* TF_MM_ALLOC_H */
